PM 說: 怎麼做出卡片的拖曳排序?

2024 iThome 鐵人賽

DAY 17

JavaScript

PM說: RD大大，這個功能要怎麼寫啊?系列第 17 篇

16th鐵人賽

YUAN

2024-09-14 21:38:05

72 瀏覽

分享至

前言

封面圖是 OPENPOINT App 的服務編輯功能
日常生活中最常看到需要拖曳排序的情境是

我的最愛(服務)
卡片列表

Drag and Drop 簡稱 DnD

如果要自己實現拖曳排序的話

程式碼會變得很長
可能會寫出效能很差的程式碼(不斷渲染)

drag相關的事件有:
dragstart, drag, dragend, dragenter, dragover, dragleave, drop
詳情可以參考 PJ大大的這篇文章

因此我們要使用SortableJS這款老牌的排序程式庫來實現

github: https://github.com/SortableJS/Sortable

成果

對卡片列表上的icon拖曳來排序demo
讀者們可以在手機&電腦上嘗試拖曳排序

上面的demo是參考官網上範例，demo將範例改成 booststrap5
並附上了官網的Grid範例

補充

1.建立的差異

//以下兩個效果一樣
Sortable.create()
new Sortable()

2.怎麼關閉&開啟排序?

可以參考: disable範例

//初始化用變數存起來
var sortable = Sortable.create(list);

switcher.onclick = function () {
//.option取屬性的值
	var state = sortable.option("disabled"); // get
//修改option屬性值
	sortable.option("disabled", !state); // set
};

搭配其他前端框架

上面的範例僅 demo UI 最後還是得回傳 data

可參考:
https://sortablejs.github.io/Sortable/#frameworks

最後一樣附上程式碼

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Sortable List Demo</title>
    <style>
      .grid-square {
        width: 150px;
        height: 100px;
        display: inline-block;
        background-color: #fff;
        border: solid 1px rgb(0, 0, 0, 0.2);
        padding: 10px;
        margin: 12px;
      }
    </style>
    <!-- Bootstrap 5 CSS -->
    <link
      href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css"
      rel="stylesheet"
    />
    <!-- Bootstrap Icons -->
    <link
      href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.7.2/font/bootstrap-icons.css"
      rel="stylesheet"
    />
    <!-- Sortable.js -->
    <script src="https://cdnjs.cloudflare.com/ajax/libs/Sortable/1.15.3/Sortable.min.js"></script>
  </head>
  <body>
    <h4>Card Example</h4>
    <div class="container mt-4">
      <!-- List with handle -->
      <div id="listWithHandle" class="list-group">
        <div
          class="list-group-item d-flex justify-content-between align-items-center"
        >
          <div>
            <i class="bi bi-arrows-move me-2" style="cursor: move"></i>
            Drag me by the handle
          </div>
          <span class="badge bg-primary rounded-pill">14</span>
        </div>
        <div
          class="list-group-item d-flex justify-content-between align-items-center"
        >
          <div>
            <i class="bi bi-arrows-move me-2" style="cursor: move"></i>
            You can also select text
          </div>
          <span class="badge bg-primary rounded-pill">2</span>
        </div>
        <div
          class="list-group-item d-flex justify-content-between align-items-center"
        >
          <div>
            <i class="bi bi-arrows-move me-2" style="cursor: move"></i>
            bootstrap@5.3.0
          </div>
          <span class="badge bg-primary rounded-pill">1</span>
        </div>
        <div
          class="list-group-item d-flex justify-content-between align-items-center"
        >
          <div>
            <i class="bi bi-arrows-move me-2" style="cursor: move"></i>
            bootstrap-icons@1.7.2
          </div>
          <span class="badge bg-primary rounded-pill">1</span>
        </div>
      </div>
    </div>

    <br />
    <h4>Service Example</h4>
    <div id="gridDemo" class="col">
      <div class="grid-square">Item 1</div>
      <div class="grid-square">Item 2</div>
      <div class="grid-square">Item 3</div>
      <div class="grid-square">Item 4</div>
      <div class="grid-square">Item 5</div>
      <div class="grid-square">Item 6</div>
      <div class="grid-square">Item 7</div>
      <div class="grid-square">Item 8</div>
      <div class="grid-square">Item 9</div>
      <div class="grid-square">Item 10</div>
    </div>

    <script>
      // List with handle
      Sortable.create(listWithHandle, {
        handle: ".bi-arrows-move",
        animation: 150,
      });

      // Grid demo
      new Sortable(gridDemo, {
        animation: 150,
        ghostClass: "blue-background-class",
      });
    </script>
  </body>
</html>